Platform Explorer / Nuxeo Platform 2021.62

Operation Directory.DeleteEntries (Deletes directory entries)

Description

Deletes directory entries. Entries ids to delete are sent through a JSON array. Returns deleted entries id as a JSON array.
Operation id Directory.DeleteEntries
Category Services
Label Deletes directory entries
Requires
Since

Parameters

Name Description Type Required Default value
directoryName string yes  
entries string yes  
markObsolete boolean no  

Signature

Inputs void
Outputs blob

Implementation Information

Implementation Class Class: org.nuxeo.ecm.automation.core.operations.services.directory.DeleteDirectoryEntries
Contributing Component org.nuxeo.ecm.core.automation.features.operations

JSON Definition

{
  "id" : "Directory.DeleteEntries",
  "label" : "Deletes directory entries",
  "category" : "Services",
  "requires" : null,
  "description" : "Deletes directory entries. Entries ids to delete are sent through a JSON array. Returns deleted entries id as a JSON array.",
  "url" : "Directory.DeleteEntries",
  "signature" : [ "void", "blob" ],
  "params" : [ {
    "name" : "directoryName",
    "description" : null,
    "type" : "string",
    "required" : true,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "entries",
    "description" : null,
    "type" : "string",
    "required" : true,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "markObsolete",
    "description" : null,
    "type" : "boolean",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  } ]
}